API — Sysadmin — tenants
Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.
POST /api/sysadmin/tenants
Create Tenant
Corpo do pedido:
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| name | string | Sim | Name |
| slug | string | Sim | Slug |
| business_name | object | Nao | Business Name |
| string | Sim | ||
| password | object | Nao | Password |
| plan | string | Nao | Plan |
| template_id | object | Nao | Template Id |
Exemplo pedido:
{
"name": "string",
"slug": "string",
"business_name": null,
"email": "string",
"password": null,
"plan": "string",
"template_id": null
}
Exemplo resposta (201):
{
"tenant": {
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
},
"admin_email": "string",
"admin_temp_password": "string"
}
Erros possiveis: 422 Validation Error
GET /api/sysadmin/tenants/{tenant_id}
Get Tenant Detail
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| tenant_id | integer | Sim | — |
Exemplo resposta (200):
{
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
}
Erros possiveis: 422 Validation Error
POST /api/sysadmin/tenants/{tenant_id}/activate
Activate Tenant
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| tenant_id | integer | Sim | — |
Exemplo resposta (200):
{
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
}
Erros possiveis: 422 Validation Error
POST /api/sysadmin/tenants/{tenant_id}/suspend
Suspend Tenant
Parametros:
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| tenant_id | integer | Sim | — |
Exemplo resposta (200):
{
"id": 0,
"slug": "string",
"name": "string",
"business_name": null,
"domain": null,
"custom_domain": null,
"domain_type": null,
"domain_status": null,
"is_active": true,
"is_demo": true,
"config": null,
"trial_ends_at": null,
"stripe_customer_id": null,
"stripe_subscription_id": null,
"stripe_connect_account_id": null,
"subscription_status": "string",
"plan": "string",
"template_id": null,
"branding_primary_color": null,
"branding_secondary_color": null,
"branding_accent_color": null,
"branding_logo_url": null,
"branding_banner_url": null,
"branding_hero_url": null,
"branding_tagline": null,
"branding_about_text": null,
"branding_cta_text": null,
"branding_show_categories": true,
"branding_show_featured": true,
"branding_social_instagram": null,
"branding_social_facebook": null,
"branding_social_whatsapp": null,
"branding_social_tiktok": null,
"phone": null,
"email": null,
"city": null,
"address": null,
"website_url": null,
"business_type": null,
"timezone": null,
"default_currency": "string",
"default_language": "string",
"tax_included_in_prices": true,
"moloni_token": null,
"moloni_company_id": null,
"created_at": null,
"updated_at": null
}
Erros possiveis: 422 Validation Error
Documentacao gerada automaticamente.